コメント(Code Smell)
コメントを消臭剤として使わない
コメントの必要性を感じたときにはリファクタリングを行って、コメントを書かなくとも内容がわかるようなコードを目指すこと。(Kindle の位置No.2542-2543)
処理の一部を説明するコメント
👉
関数の抽出
(自己文書化)
抽出済みの関数で、コメントがないと分かりづらい
👉
関数宣言の変更
特定の状態を必要としている
👉アサーションの導入
コメントに
不明点を書き留めておく
修正に役立てるため
なぜこのような処理を選択したのかも書く
コメンタリー
(『リーダブルコード』)